Skip to main content

Activates or deactivates delivery orders

PUT {{base_url}}/delivery-orders/{deliveryOrderUuid}/activate

Description

This API endpoint activates or deactivates delivery orders based on the provided UUID.

Request

Headers:

NameDescription
countryCodeA string representing the country code.
tenantIdA string identifying the tenant.

Path Parameters:

NameDescription
deliveryOrderUuidThe unique identifier of the delivery order.

Request Body:

{
"userId": "string",
"isActive": true
}


Responses:

200 OK:

{
"status": true,
"statusCode": 0,
"message": "Delivery orders activation status updated successfully.",
"data": {},
"errors": []
}


400 Bad Request

{
"status": false,
"statusCode": 400,
"message": "Invalid reference supplied.",
"errors": [
{
"message": "Invalid reference supplied.",
"descriptiveMessage": "The provided reference is not valid. Please ensure correct values are supplied."
}
]
}


404 Not Found

{
"status": false,
"statusCode": 404,
"message": "Activate or De-activate delivery orders not successful.",
"errors": [
{
"message": "Activate or De-activate delivery orders not successful.",
"descriptiveMessage": "The request to activate or de-activate delivery orders was not successful."
}
]
}


LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PUT \ 
--url /delivery-orders/{deliveryOrderUuid}/activate \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!